<!-- HTML header for doxygen 1.8.10-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.9.3"/>
<title>NATS C Client with JetStream and Streaming support: jsOptions::jsOptionsStream::jsOptionsStreamPurge Struct Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="customdoxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;" >
   <div id="projectname">NATS C Client with JetStream and Streaming support
   &#160;<span id="projectnumber">3.3.0</span>
   </div>
   <div id="projectbrief">The nats.io C Client, Supported by Synadia Communications Inc.</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.3 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search",'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function(){initNavTree('structjs_options_1_1js_options_stream_1_1js_options_stream_purge.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="summary">
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="structjs_options_1_1js_options_stream_1_1js_options_stream_purge-members.html">List of all members</a>  </div>
  <div class="headertitle"><div class="title">jsOptions::jsOptionsStream::jsOptionsStreamPurge Struct Reference</div></div>
</div><!--header-->
<div class="contents">

<p><code>#include &lt;<a class="el" href="nats_8h_source.html">nats.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:aa99e6ee3bef1c22243f01544181315fe"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structjs_options_1_1js_options_stream_1_1js_options_stream_purge.html#aa99e6ee3bef1c22243f01544181315fe">Subject</a></td></tr>
<tr class="memdesc:aa99e6ee3bef1c22243f01544181315fe"><td class="mdescLeft">&#160;</td><td class="mdescRight">This is the subject to match against messages for the purge command.  <a href="structjs_options_1_1js_options_stream_1_1js_options_stream_purge.html#aa99e6ee3bef1c22243f01544181315fe">More...</a><br /></td></tr>
<tr class="separator:aa99e6ee3bef1c22243f01544181315fe"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0d61e5d3c9c518f455549086ababe7f6"><td class="memItemLeft" align="right" valign="top">uint64_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structjs_options_1_1js_options_stream_1_1js_options_stream_purge.html#a0d61e5d3c9c518f455549086ababe7f6">Sequence</a></td></tr>
<tr class="memdesc:a0d61e5d3c9c518f455549086ababe7f6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Purge up to but not including sequence.  <a href="structjs_options_1_1js_options_stream_1_1js_options_stream_purge.html#a0d61e5d3c9c518f455549086ababe7f6">More...</a><br /></td></tr>
<tr class="separator:a0d61e5d3c9c518f455549086ababe7f6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a882c1ce1e636817450893caa72aa4eda"><td class="memItemLeft" align="right" valign="top">uint64_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structjs_options_1_1js_options_stream_1_1js_options_stream_purge.html#a882c1ce1e636817450893caa72aa4eda">Keep</a></td></tr>
<tr class="memdesc:a882c1ce1e636817450893caa72aa4eda"><td class="mdescLeft">&#160;</td><td class="mdescRight">Number of messages to keep.  <a href="structjs_options_1_1js_options_stream_1_1js_options_stream_purge.html#a882c1ce1e636817450893caa72aa4eda">More...</a><br /></td></tr>
<tr class="separator:a882c1ce1e636817450893caa72aa4eda"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p >Advanced stream purge options</p>
<ul>
<li><code>Subject</code> will filter the purge request to only messages that match the subject, which can have wildcards.<br  />
</li>
<li><code>Sequence</code> will purge up to but not including this sequence and can be combined with subject filtering.<br  />
</li>
<li><code>Keep</code> will specify how many messages to keep and can be combined with subject filtering.<br  />
</li>
</ul>
<dl class="section note"><dt>Note</dt><dd><code>Sequence</code> and <code>Keep</code> are mutually exclusive, so both can not be set at the same time. </dd></dl>
</div><h2 class="groupheader">Member Data Documentation</h2>
<a id="aa99e6ee3bef1c22243f01544181315fe" name="aa99e6ee3bef1c22243f01544181315fe"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa99e6ee3bef1c22243f01544181315fe">&#9670;&nbsp;</a></span>Subject</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const char* jsOptions::jsOptionsStream::jsOptionsStreamPurge::Subject</td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<a id="a0d61e5d3c9c518f455549086ababe7f6" name="a0d61e5d3c9c518f455549086ababe7f6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0d61e5d3c9c518f455549086ababe7f6">&#9670;&nbsp;</a></span>Sequence</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint64_t jsOptions::jsOptionsStream::jsOptionsStreamPurge::Sequence</td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<a id="a882c1ce1e636817450893caa72aa4eda" name="a882c1ce1e636817450893caa72aa4eda"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a882c1ce1e636817450893caa72aa4eda">&#9670;&nbsp;</a></span>Keep</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint64_t jsOptions::jsOptionsStream::jsOptionsStreamPurge::Keep</td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li><a class="el" href="nats_8h_source.html">nats.h</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- HTML footer for doxygen 1.8.10-->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="structjs_options.html">jsOptions</a></li><li class="navelem"><a class="el" href="structjs_options_1_1js_options_stream.html">jsOptionsStream</a></li><li class="navelem"><a class="el" href="structjs_options_1_1js_options_stream_1_1js_options_stream_purge.html">jsOptionsStreamPurge</a></li>
    <li class="footer">NATS.IO Supported By Synadia Communications Inc.
    <a href="http://www.nats.io">
    </a></li>
  </ul>
</div>
</body>
</html>
